Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for Caikit Standalone ServingRuntime #343

Merged
merged 13 commits into from
Jul 2, 2024

Conversation

eturner24
Copy link
Contributor

@eturner24 eturner24 commented Jun 27, 2024

Description

Update documentation to indicate that we now support the Caikit Standalone ServingRuntime.

How Has This Been Tested?

  • Made updates and started local Gatsby build to preview doc page updates in my browser

Merge criteria:

  • The commits are squashed in a cohesive manner and have meaningful messages.
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • The developer has manually tested the changes and verified that the changes work

- Added Caikit Standalone ServingRuntime as a model option
- Outlined endpoints available for use
- Provided example output for endpoints
- Added metrics information
modules/about-the-single-model-serving-platform.adoc Outdated Show resolved Hide resolved
* `:443 caikit.runtime.Nlp.NlpService/RerankTasksPredict`
+
ifdef::upstream[]
NOTE: By default, the Caikit Standalone ServingRuntime exposes REST endpoints for use. To use gRPC protocol, manually deploy a custom Caikit Standalone ServingRuntime. For more information, see link:{odhdocshome}/serving-models/#adding-a-custom-model-serving-runtime-for-the-single-model-serving-platform_serving-large-models[Adding a custom model-serving runtime for the single-model serving platform].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably settle on 'HTTP endpoints', rather than 'REST endpoints'. I think HTTP will be the protocol that's indicated next to the inference endpoint in the dashboard.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's displayed as "REST" but I'm fine with either:
Screenshot 2024-07-02 at 9 46 30 AM

Copy link
Contributor

@jbyrne-redhat jbyrne-redhat Jul 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, thanks for confirming, @christinaexyou 👍 In that case, let's do the opposite and title the bullet list of endpoints to match? And the example queries, too?

@eturner24 eturner24 merged commit 168ef99 into opendatahub-io:main Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants